docs: add heph validate guide and update CI guide#46
Merged
Conversation
heph validate was undocumented. PR hephbuild/heph#123 improved its behavior to report all failures at once instead of stopping at the first one, making it a clean CI gate. Document it and update the CI guide to use it in place of the manual gitignore check.
⚡ Cloudflare Pages preview
|
raphaelvigee
commented
Jun 24, 2026
Member
Author
There was a problem hiding this comment.
remove all the --no-tui flags
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed\n\n
heph validatewas completely undocumented. hephbuild/heph#123 improved its behavior to report all failures at once (not just the first), making it a solid CI gate. This PR documents the command and threads it into the CI guide.\n\n### New page:guides/validate.md\n\nCovers:\n- The three checks validate runs (target link, codegen overlap,.gitignorefreshness)\n- Whole-workspace vs. scoped (//pkg/...) usage\n- CI usage with--no-tui\n\n### Updated:guides/ci.md\n\nReplaces the manual.gitignorecheck:\nbash\n# before\nheph tool gen-gitignore\ngit diff --exit-code .gitignore\n\n# after\nheph validate --no-tui\n\n\nheph validateis read-only, reports all problems at once, and covers the gitignore check alongside the other two checks — a strictly better fit for CI.\n\n### Updated:website/sidebars.ts\n\nAddsguides/validateto the Guides category (between CI and Remote Cache).\n\n---\n\nTriggered by: hephbuild/heph@b95f010 (hephbuild/heph#123)"Generated by Claude Code